Class symantec.itools.db.beans.util.ObjectFinder
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class symantec.itools.db.beans.util.ObjectFinder

Object
   |
   +----symantec.itools.db.beans.util.ObjectFinder

public class ObjectFinder
extends Object
ObjectFinder is a class which provides functionality for finding database components in a Visual Cafe project.


Variable Index

 o brlBeans
 o conMgrs
 o derivAdapterBeans
 o queryNavs
 o recordDefs
 o scINIFile
 o sqlStmts
 o sqlrecordDefs
 o validAdapterBeans
 o vcafeEnv
 o visualObjs
 o visualProj

Constructor Index

 o symantec.itools.db.beans.util.ObjectFinder()
Constructor

Method Index

 o findQueryNavVObjByAliasName(String)
Find a QueryNavigator VisualObject by its alias name
 o findVisualProperty(VisualProperty[], String)
Method to find a visual property by its name from the array of bean's visual properties.
 o getBRLAdapterBeans()
Method to return a list of business rule objects that are present in the current project
 o getBaseRecordDefintionClassNames()
Function to return an array of the RecordDefintion class names
 o getColumnNameForBRLBean(VisualObject)
Method to get the column name for a given VisualObject.
 o getColumnsForQueryNav(VisualObject)
Method to return a list of columns for a specific queryNavigator
 o getColumnsForRecordDef(RecordDefinition)
Get columns from RecordDefinition object.
 o getConectionManager(String)
Function returns an instantiated ConnectionManager class
 o getConectionManager(String, Boolean)
Function returns an instantiated ConnectionManager class
 o getConectionManagers()
Function returns a Vector of com.symantec.itools.vcafe.openapi.VisualObject which are instances of symantec.itools.db.beans.ConectionManager This Vector should contain ONLY ONE element
 o getConectionManagersClassNames()
Function to return an array of the ConnectionManager class names This array should contain ONLY ONE element
 o getDataModelForQueryNav(VisualObject)
Function to return the DataModel from a query navigator
 o getDataModelForQueryNav(VisualObject, boolean)
Function to return the DataModel from a query navigator
 o getDatabindNameForBRLBean(VisualObject)
Method to get the databinding name for a given VisualObject.
 o getDatabindNameForSQLstatement(VisualObject)
Method to get the databinding name for a given VisualObject.
 o getDerivationAdapterBeans()
Method to return a list of derived columns that are present in the current project
 o getDesignTimeData(String, Integer)
Function which returns design time data for a Query Navigator The Query Navigator is specified by its alias name
 o getDesignTimeData(VisualObject, int)
Function which returns design time data for a current Query Navigator
 o getDesignTimeSetting()
Method to return the current design time setting based upon the setting in SC.INI
 o getINIFile()
 o getParameterMetaDataForSQLStatement(VisualObject)
Method to get the ParameterMetaData[] for a given VisualObject.
 o getParameterNamesForSQLstatement(VisualObject)
Method to get the databinding name for a given VisualObject.
 o getProjBuildStatus()
Method to return project build status
 o getQueryNavigators()
Function returns a Vector of com.symantec.itools.vcafe.openapi.VisualObject which are instances of symantec.itools.db.beans.QueryNavigator
 o getRecordDefForQueryNav(VisualObject)
Return instantiated RecordDefinition object for query navigator
 o getRecordDefVisualObjForQueryNav(VisualObject)
Return visualobject for record defintion for a given query navigator
 o getRecordDefintionClassNames()
Function to return an array of the RecordDefintion class names
 o getResultColumnsForSQLAdapter(VisualObject)
Return result set columns for a SQLAdapter
 o getSQLAdapterVisualObjForQueryNav(VisualObject)
Return visualobject for SQLAdapter for a given query navigator
 o getSQLRecordDefintionClassNames()
Function to return an array of the RecordDefintion class names
 o getSQLstatements()
Function returns a Vector of com.symantec.itools.vcafe.openapi.VisualObject which are instances of symantec.itools.db.beans.SQLAdapter
 o getValidationAdapterBeans()
Method to return a list of validated columns that are present in the current project
 o isDesignTimeDataNecessary()
Method to determine if design time data should be obtained.
 o setProjBuildStatus(boolean)
Method to set the project built status

Variables

 o brlBeans
protected java.util.Vector brlBeans
 o conMgrs
protected java.util.Vector conMgrs
 o derivAdapterBeans
protected java.util.Vector derivAdapterBeans
 o queryNavs
protected java.util.Vector queryNavs
 o recordDefs
protected java.util.Vector recordDefs
 o scINIFile
protected static symantec.itools.vcafe.inioptions.VisualCafeINI scINIFile
 o sqlStmts
protected java.util.Vector sqlStmts
 o sqlrecordDefs
protected java.util.Vector sqlrecordDefs
 o validAdapterBeans
protected java.util.Vector validAdapterBeans
 o vcafeEnv
protected com.symantec.itools.vcafe.openapi.VisualCafe vcafeEnv
 o visualObjs
protected com.symantec.itools.vcafe.openapi.VisualObject[] visualObjs
 o visualProj
protected com.symantec.itools.vcafe.openapi.VisualProject visualProj

Constructors

 o ObjectFinder
public ObjectFinder()
Constructor

Methods

 o findQueryNavVObjByAliasName
public com.symantec.itools.vcafe.openapi.VisualObject findQueryNavVObjByAliasName(String queryNavAliasName)
Find a QueryNavigator VisualObject by its alias name

Parameters:
queryNavAliasName - is an alias name for a query Navigator
Returns:
a QueryNavigator VisualObject with the specified alias name
 o findVisualProperty
public static com.symantec.itools.vcafe.openapi.VisualProperty findVisualProperty(VisualProperty[] visualProps,
                                                                                  String propName)
Method to find a visual property by its name from the array of bean's visual properties.

Parameters:
visualProps - is the array returned by com.symantec.itools.vcafe.openapi.VisualObject.getProperties() method
propName - is the property display name. If you are using java.beans.PropertyDescriptor.setDisplayName() in you BeanInfo then you should use the same value here for propName.
Returns:
The visual property named propName
 o getBRLAdapterBeans
public java.util.Vector getBRLAdapterBeans()
Method to return a list of business rule objects that are present in the current project

Returns:
Vector of CompColAdapterBean VisualObjects
 o getBaseRecordDefintionClassNames
public java.lang.String[] getBaseRecordDefintionClassNames()
Function to return an array of the RecordDefintion class names

Returns:
String array of RecordDefintion class names
 o getColumnNameForBRLBean
public java.lang.String getColumnNameForBRLBean(VisualObject vObj)
Method to get the column name for a given VisualObject.

Parameters:
VisualObject - for CompColAdapterBean
Returns:
String
 o getColumnsForQueryNav
public java.lang.String[] getColumnsForQueryNav(VisualObject queryNav)
Method to return a list of columns for a specific queryNavigator

Parameters:
VisualObject - for query Navigator
Returns:
String[] of columns for QueryNavigator
 o getColumnsForRecordDef
public java.lang.String[] getColumnsForRecordDef(RecordDefinition recordDef)
Get columns from RecordDefinition object. Note: The column list returned is static.

Parameters:
RecordDefinition - object
Returns:
String array of columns
 o getConectionManager
public symantec.itools.db.beans.jdbc.ConnectionManager getConectionManager(String connMgrClassName)
Function returns an instantiated ConnectionManager class

Returns:
ConnectionManager
 o getConectionManager
public symantec.itools.db.beans.jdbc.ConnectionManager getConectionManager(String connMgrClassName,
                                                                           Boolean BuildFlag)
Function returns an instantiated ConnectionManager class

Parameters:
connMgrClassName - is the name of the class that will be instantiated
Returns:
ConnectionManager
 o getConectionManagers
public java.util.Vector getConectionManagers()
Function returns a Vector of com.symantec.itools.vcafe.openapi.VisualObject which are instances of symantec.itools.db.beans.ConectionManager This Vector should contain ONLY ONE element

Returns:
Vector of VisualObjects for ConnectionManager
 o getConectionManagersClassNames
public java.lang.String[] getConectionManagersClassNames()
Function to return an array of the ConnectionManager class names This array should contain ONLY ONE element

Returns:
String array of Connection Manager class names
 o getDataModelForQueryNav
public symantec.itools.db.beans.jdbc.DataModel getDataModelForQueryNav(VisualObject queryNav)
Function to return the DataModel from a query navigator

Parameters:
- - VisualObject for QueryNavigator
Returns:
- DataModel containing design time information
 o getDataModelForQueryNav
public symantec.itools.db.beans.jdbc.DataModel getDataModelForQueryNav(VisualObject queryNav,
                                                                       boolean specialFeatures)
Function to return the DataModel from a query navigator

Parameters:
- - VisualObject for QueryNavigator
- - boolean indicating true or false
Returns:
- DataModel containing design time information
 o getDatabindNameForBRLBean
public java.lang.String getDatabindNameForBRLBean(VisualObject vObj)
Method to get the databinding name for a given VisualObject.

Parameters:
VisualObject - for CompColAdapterBean
Returns:
String
 o getDatabindNameForSQLstatement
public java.lang.String getDatabindNameForSQLstatement(VisualObject vObj)
Method to get the databinding name for a given VisualObject.

Parameters:
VisualObject - for SQLstatement
Returns:
String
 o getDerivationAdapterBeans
public java.util.Vector getDerivationAdapterBeans()
Method to return a list of derived columns that are present in the current project

Returns:
Vector of CalculationAdapter VisualObjects
 o getDesignTimeData
public java.util.Hashtable getDesignTimeData(String queryNavAliasName,
                                             Integer designTimeRows)
Function which returns design time data for a Query Navigator The Query Navigator is specified by its alias name

Parameters:
queryNavAliasName - is an alias name for a query Navigator
int - for number of rows requested
Returns:
vector of hash table
 o getDesignTimeData
public java.util.Hashtable getDesignTimeData(VisualObject queryNavVObj,
                                             int designTimeRows)
Function which returns design time data for a current Query Navigator

Parameters:
VisualObject - for query Navigator
int - for number of rows requested
Returns:
vector of hash table
 o getDesignTimeSetting
public int getDesignTimeSetting()
Method to return the current design time setting based upon the setting in SC.INI

Returns:
integer value
 o getINIFile
protected static symantec.itools.vcafe.inioptions.VisualCafeINI getINIFile()
 o getParameterMetaDataForSQLStatement
public symantec.itools.db.beans.jdbc.ParameterMetaData[] getParameterMetaDataForSQLStatement(VisualObject vObj)
Method to get the ParameterMetaData[] for a given VisualObject.

Parameters:
VisualObject - for SQLStatement
Returns:
ParameterMetaData[]
 o getParameterNamesForSQLstatement
public java.lang.String[] getParameterNamesForSQLstatement(VisualObject vObj)
Method to get the databinding name for a given VisualObject.

Parameters:
VisualObject - for SQLstatement
Returns:
String[] with the names of all parameters
 o getProjBuildStatus
public static boolean getProjBuildStatus()
Method to return project build status

Returns:
true or false
 o getQueryNavigators
public java.util.Vector getQueryNavigators()
Function returns a Vector of com.symantec.itools.vcafe.openapi.VisualObject which are instances of symantec.itools.db.beans.QueryNavigator

Returns:
Vector of QueryNavigator VisualObjects
 o getRecordDefForQueryNav
public symantec.itools.db.beans.jdbc.RecordDefinition getRecordDefForQueryNav(VisualObject queryNav)
Return instantiated RecordDefinition object for query navigator

Parameters:
VisualObject - - query Navigator
Returns:
RecordDefinition
 o getRecordDefVisualObjForQueryNav
public com.symantec.itools.vcafe.openapi.VisualObject getRecordDefVisualObjForQueryNav(VisualObject queryNav)
Return visualobject for record defintion for a given query navigator

Parameters:
VisualObject - for query navigator
Returns:
VisualObject for record definition
 o getRecordDefintionClassNames
public java.lang.String[] getRecordDefintionClassNames()
Function to return an array of the RecordDefintion class names

Returns:
String array of RecordDefintion class names
 o getResultColumnsForSQLAdapter
public java.lang.String[] getResultColumnsForSQLAdapter(VisualObject SQLAdapterVObj)
Return result set columns for a SQLAdapter

Parameters:
VisualObject - for SQLAdapter
Returns:
resultset column names in a string array
 o getSQLAdapterVisualObjForQueryNav
public com.symantec.itools.vcafe.openapi.VisualObject getSQLAdapterVisualObjForQueryNav(VisualObject queryNav)
Return visualobject for SQLAdapter for a given query navigator

Parameters:
VisualObject - for query navigator
Returns:
VisualObject for SQLAdapter
 o getSQLRecordDefintionClassNames
public java.lang.String[] getSQLRecordDefintionClassNames()
Function to return an array of the RecordDefintion class names

Returns:
String array of RecordDefintion class names
 o getSQLstatements
public java.util.Vector getSQLstatements()
Function returns a Vector of com.symantec.itools.vcafe.openapi.VisualObject which are instances of symantec.itools.db.beans.SQLAdapter

Returns:
Vector for SQL Statements [ie] Stored Procedures/SQL Beans
 o getValidationAdapterBeans
public java.util.Vector getValidationAdapterBeans()
Method to return a list of validated columns that are present in the current project

Returns:
Vector of ValidationAdapter VisualObjects
 o isDesignTimeDataNecessary
public boolean isDesignTimeDataNecessary()
Method to determine if design time data should be obtained. Read the SC.INI and check for DB_DESIGN_DATA entry. If the value is LIVE_DATA_OFF, then always return false. If the value is LIVE_DATA_COLUMN or LIVE_DATA_ON, check the backrun status. If backrunner is running, return false else return true.

Returns:
true or false
 o setProjBuildStatus
public static void setProjBuildStatus(boolean val)
Method to set the project built status

Parameters:
true - or false indicating project built status

All Packages  Class Hierarchy  This Package  Previous  Next  Index